/*
 * Copyright (c) 2025, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package jdk.jpackage.internal.model;

import java.lang.module.ModuleFinder;
import java.nio.file.Path;
import java.util.List;

/**
 * Creates Java runtime.
 */
@FunctionalInterface
public interface RuntimeBuilder {

    /**
     * Creates Java runtime in the given app image.
     *
     * @implNote Java runtime should be created in the directory returned by
     *           {@link AppImageLayout#runtimeDirectory()} method called on the
     *           given app image layout object.
     *
     * @param appImageLayout the app image where to create Java runtime.
     * @throws PackagerException if packaging error occurs
     */
    void create(AppImageLayout appImageLayout);

    /**
     * Returns {@code true} if "--strip-native-commands" was not used with jlink.
     * Default implementation returns {@code false}.
     *
     * @return {@code true} if "--strip-native-commands" was not used with jlink
     */
    default boolean withNativeCommands() {
        return false;
    }

    /**
     * Gets the default set of paths where jlink should look up for system Java
     * modules.
     *
     * <p>
     * These paths are for {@code jlink} command. Using them with
     * {@link ModuleFinder#of(Path...)} may not work as expected: attempt to find
     * "java.base" module in these paths will fail.
     *
     * @return the default set of paths where to find Java modules
     */
    public static List<Path> getDefaultModulePath() {
        return List.of(
                Path.of(System.getProperty("java.home"), "jmods").toAbsolutePath());
    }
}
